
<!DOCTYPE html>
<!--

    Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.

    This program and the accompanying materials are made available under the
    terms of the Eclipse Public License v. 2.0, which is available at
    http://www.eclipse.org/legal/epl-2.0.

    This Source Code may also be made available under the following Secondary
    Licenses when the conditions for such availability set forth in the
    Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
    version 2 with the GNU Classpath Exception, which is available at
    https://www.gnu.org/software/classpath/license.html.

    SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->
<!-- Portions Copyright [2019] [Payara Foundation and/or its affiliates] -->
<html lang="en">
  <head>
    <meta charset="utf-8"/>
    <title>add-library</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link href="css/style.css" rel="stylesheet">
    <script src="https://use.fontawesome.com/96c4d89611.js"></script>
  </head>
  <body>
<table id="doc-title" cellspacing="0" cellpadding="0">
  <tr>
  <td align="left" valign="top">
  <b>add-library</b><br />
  </td>
  </tr>
</table>
<hr />

<table width="90%" id="top-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>
		<td align="left">
		<a href="manvol1.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="add-resources.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class=" vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>


<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p><a id="add-library-1"></a><a id="GSRFM00818"></a><a id="add-library"></a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_add_library">add-library</h2>
<div class="sectionbody">
<div class="paragraph">
<p>adds one or more library JAR files to \{product---name}</p>
</div>
<div id="sthref7" class="paragraph">
<p>Synopsis</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin [asadmin-options] add-library [--help]
[--type={common|ext|app}] [--upload={false|true}]
library-file-path [library-file-path ... ]</code></pre>
</div>
</div>
<div id="sthref8" class="paragraph">
<p>Description</p>
</div>
<div class="paragraph">
<p>The <code>add-library</code> subcommand adds one or more library archive files to
\{product---name}.</p>
</div>
<div class="paragraph">
<p>The <code>--type</code> option specifies the library type and the \{product---name}
directory to which the library is added.</p>
</div>
<div class="paragraph">
<p>The library-file-path operand is the path to the JAR file that contains
the library to be added. To specify multiple libraries, specify multiple
paths separated by spaces.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
<div class="paragraph">
<p>The library archive file is added to the DAS. For common and extension
libraries, you must restart the DAS so the libraries are picked up by
the server runtime. To add the libraries to other server instances,
synchronize the instances with the DAS by restarting them.</p>
</div>
</td>
</tr>
</table>
</div>
<div class="paragraph">
<p>This subcommand is supported in remote mode only.</p>
</div>
<div id="sthref9" class="paragraph">
<p>Options</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">asadmin-options</dt>
<dd>
<p>Options for the <code>asadmin</code> utility. For information about these
options, see the <a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a> help page.</p>
</dd>
<dt class="hdlist1"><code>--help</code></dt>
<dt class="hdlist1"><code>-?</code></dt>
<dd>
<p>Displays the help text for the subcommand.</p>
</dd>
<dt class="hdlist1"><code>--type</code></dt>
<dd>
<p>Specifies the library type and the \{product---name} directory to
which the library is added. Valid values are as follows:<br></p>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>common</code></dt>
<dd>
<p>Adds the library files to the Common class loader directory,
domain-dir`/lib`. This is the default.</p>
</dd>
<dt class="hdlist1"><code>ext</code></dt>
<dd>
<p>Adds the library files to the Java optional package directory,
domain-dir`/lib/ext`.</p>
</dd>
<dt class="hdlist1"><code>app</code></dt>
<dd>
<p>  Adds the library files to the application-specific class loader
  directory, domain-dir`/lib/applibs`.<br>
For more information about these directories, see
"<a href="../application-development-guide/class-loaders.html#GSDVG00003">Class Loaders</a>" in Payara Server Open Source
Edition Application Development Guide.</p>
</dd>
</dl>
</div>
</dd>
<dt class="hdlist1"><code>--upload</code></dt>
<dd>
<p>Specifies whether the subcommand uploads the file to the DAS. In most
situations, this option can be omitted.<br>
Valid values are as follows:<br></p>
<div class="dlist">
<dl>
<dt class="hdlist1"><code>false</code></dt>
<dd>
<p>The subcommand does not upload the file and attempts to access the
file through the specified file name. If the DAS cannot access the
file, the subcommand fails.<br>
For example, the DAS might be running as a different user than the
administration user and does not have read access to the file. In
this situation, the subcommand fails if the <code>--upload</code> option is
<code>false</code>.</p>
</dd>
<dt class="hdlist1"><code>true</code></dt>
<dd>
<p>  The subcommand uploads the file to the DAS over the network
  connection.<br>
The default value depends on whether the DAS is on the host where the
subcommand is run or is on a remote host.<br></p>
<div class="ulist">
<ul>
<li>
<p>If the DAS is on the host where the subcommand is run, the default
is <code>false</code>.</p>
</li>
<li>
<p>If the DAS is on a remote host, the default is <code>true</code>.<br>
If a directory filepath is specified, this option is ignored.</p>
</li>
</ul>
</div>
</dd>
</dl>
</div>
</dd>
</dl>
</div>
<div id="sthref10" class="paragraph">
<p>Operands</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">library-file-path</dt>
<dd>
<p>The paths to the archive files that contain the libraries that are to
be added. You can specify an absolute path or a relative path.<br>
If the <code>--upload</code> option is set to <code>true</code>, this is the path to the
file on the local client machine. If the <code>--upload</code> option is set to
<code>false</code>, this is the path to the file on the server machine.</p>
</dd>
</dl>
</div>
<div id="sthref11" class="paragraph">
<p>Examples</p>
</div>
<div class="paragraph">
<p><a id="GSRFM824"></a><a id="sthref12"></a></p>
</div>
<div class="paragraph">
<p>Example 1   Adding Libraries</p>
</div>
<div class="paragraph">
<p>This example adds the library in the archive file <code>mylib.jar</code> to the
application-specific class loader directory on the default server
instance.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin&gt; add-library --type app /tmp/mylib.jar
Command add-library executed successfully.</code></pre>
</div>
</div>
<div id="sthref13" class="paragraph">
<p>Exit Status</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">0</dt>
<dd>
<p>subcommand executed successfully</p>
</dd>
<dt class="hdlist1">1</dt>
<dd>
<p>error in executing the subcommand</p>
</dd>
</dl>
</div>
<div id="sthref14" class="paragraph">
<p>See Also</p>
</div>
<div class="paragraph">
<p><a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a></p>
</div>
<div class="paragraph">
<p><a href="list-libraries.html#list-libraries-1"><code>list-libraries</code>(1)</a>,
<a href="remove-library.html#remove-library-1"><code>remove-library</code>(1)</a></p>
</div>
<div class="paragraph">
<p>"<a href="../application-development-guide/class-loaders.html#GSDVG00003">Class Loaders</a>" in Payara Server Open Source
Edition Application Development Guide</p>
</div>
</div>
</div>

<hr />

<table width="90%" id="bottom-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>		
		<td align="left">
		<a href="manvol1.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="add-resources.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class="vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>

<span id="copyright">
        <img src="/resource/reference/img/eclipse_foundation_logo_tiny.png" height="20px" alt="Eclipse Foundation Logo" align="top"/>&nbsp;            
        <span >Copyright&nbsp;&copy;&nbsp;2019,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span>
</span>

</body>
</html>
